<HTML>
<HEAD>
<TITLE>HELP - SpecialSections.page</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - SpecialSections.page</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','Documenting0',this)" class="pathLink">Documenting</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">SpecialSections.page</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_file','SpecialSections_page0','_description',this)" class="tabLinkInActive">Description</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Overview</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Included files</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Included by</span></span>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_file','SpecialSections_page0','_source',this)" class="tabLinkActive">Source</a></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<pre class="codeExamples">
/**
\page "Special Sections"
!!! Special sections (Notes, Todo, etc.)
Special section are used to document return values, author notes etc. Common 
to all section commands is the fact that the section continues until a blank 
line or another section command is encountered.

!Multiple use of these makes a bulleted list
| #Syntax# | #Reference manual # | #Example# 
|| $\\bug ... text ...$ | bugCmd | HowToDocument::Bug
|| $\\deprecated ... text ...$ | deprecatedCmd | HowToDocument::Deprecated
|| $\\throw \<exception_name\> ... text ...$ | throwCmd | HowToDocument::ExceptionsThrown
|| $\\internal ... text ...$ | internalCmd | HowToDocument::Internal
|| $\\note ... text ...$ | noteCmd | HowToDocument::Note
|| $\\param ... text ...$ | paramCmd | HowToDocument::ParametersJavaStyle
|| $\\remark ... text ...$ | remarkCmd | HowToDocument::Remark
|| $\\sa ... text ...$ | saCmd | HowToDocument::SeeAlso
|| $\\todo ... text ...$ | todoCmd | HowToDocument::Todo
|| $\\warning ... text ...$ | warningCmd | HowToDocument::Warning

! Only intended to be used once per entity (multiples are concatenated)
| #Syntax# | #Reference manual # | #Example# 
|| $\\author ... text ...$ | authorCmd | HowToDocument::Author
|| $\\brief ... text ...$ | briefCmd | HowToDocument::BriefCmd
|| $\\return ... text ...$ | returnCmd | HowToDocument::ReturnValue
|| $\\version ... text ...$ | versionCmd | HowToDocument::Version
*/
</pre><div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_file','_source');
</script>
